// --------------------------------------------------------------------------------------------------------------------
// <copyright file="ProjectorState.cs" company="Microsoft Corporation">
// The MIT License (MIT)
// 
// Copyright (c) 2014, Microsoft Corporation
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
//  of this software and associated documentation files (the "Software"), to deal
//  in the Software without restriction, including without limitation the rights
//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the Software is
//  furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
//  all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
//  THE SOFTWARE.
// </copyright>
// --------------------------------------------------------------------------------------------------------------------
namespace Microsoft.Robotics.Hardware.DAC
{
    using System.Runtime.Serialization;

    using Microsoft.Robotics.Numerics;

    /// <summary>
    /// The projector state class
    /// </summary>
    [DataContract]
    public class ProjectorState : IDeviceState
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="ProjectorState"/> class.
        /// </summary>
        public ProjectorState()
        {
        }

        /// <summary> 
        /// Gets or sets a value indicating whether the inversion state of the projector image horizontally
        /// </summary>
        [DataMember]
        public bool HorizontialInversion { get; set; }

        /// <summary> 
        /// Gets or sets a value indicating whether the inversion state of the projector image vertically
        /// </summary>
        [DataMember]
        public bool VerticalInversion { get; set; }

        /// <summary>
        /// Gets or sets the projector brightness setting
        /// </summary>
        [DataMember]
        public short Brightness { get; set; }

        /// <summary>
        /// Gets or sets the focus length offset from home position
        /// </summary>
        [DataMember]
        public short FocalLengthOffset { get; set; }

        /// <summary>
        /// Gets or sets the timestamp for the state.
        /// </summary>
        [DataMember]
        public long TimestampInTicks { get; set; }

        /// <summary>
        /// Gets or sets the timestamp in milliseconds (as opposed to hardware-dependent ticks).
        /// </summary>
        [DataMember]
        public long TimestampInMilliseconds { get; set; }

        /// <summary>
        /// Gets or sets the device identifier
        /// </summary>
        [DataMember]
        public int DeviceId { get; set; }

        /// <summary>
        /// Gets or sets the device model information
        /// </summary>
        [DataMember]
        public string Model { get; set; }

        /// <summary>
        /// Gets or sets the type of the device the sensor is related
        /// </summary>
        [DataMember]
        public DeviceType DeviceType { get; set; }

        /// <summary>
        /// Gets or sets the pose for the device/sensor
        /// </summary>
        [DataMember]
        public Pose Pose { get; set; }
    }
}
